time: clarify the cancellation safety of the DelayQueue
#7564
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ADD-SP
added
T-docs
ADD-SP
changed the title
DelayQueue's StreamExt::next implementationDelayQueue
Contributor
Author
|
Thanks for the review! @ADD-SP |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Resolves #7374
The usage of a
DelayQueueoften involves using its implementation ofStreamExt::nextinselect!statements, where users need to know whether the method is cancellation safe or not.DelayQueue'sStream::poll_nextimplementation which is backed bypoll_expireddoes not maintain any intermediary state with side effects on its internal state when returningPending, thusStreamExt::nextshould be cancellation safe.Solution
Added a note that its implementation is cancellation safe.